Interface output.log
Communicates info, warning and error messages from the
execution.
The output log is used for displaying messages that might be of
value to the user. They are usually set based on some condition
in execution and they are transient, meaning that they will
disappear in the next execution (unless set again). The messages
are only shown in the user interface and are not stored. There
are three different message types: info, warning and
error, and there can be any number
of messages of each type. See the corresponding methods for a
description of each type.
- output.log.error(message)
- Arguments:
message (
string)
Log an error message. This is used for notifying the user of more severe problems that prevents the tool from executing correctly.
- output.log.info(message)
- Arguments:
message (
string)
Log an informational message. This is used for notifying the user of things that they should be aware of, but that is not necessarily a problem.
- output.log.warning(message)
- Arguments:
message (
string)
Log a warning message. This is used for notifying the user of problems that might impact the functionality or performance of the tool.
Log usage
To display a warning message to the user, call the log.warning function
from execute:
output.log.warning("This is a warning message")
When there are one or more log messages the Issues section will appear in the tool panel to display the messages:
The messages will also be visible from the issues list in the top of the interface:
See also
String access in Lua for translating log messages